api_request Element

Description

Starts a connection request.

Namespace

(none)

Diagram

Overview

api_request

Starts a connection request.

Sequence

action xs:string

One of nine action types. This lets us know the type of connection you wish to make and what you need the API to do for you. In the case of requesting a list the action type is "list".

username xs:string

The username of this user as stored on the PRODOCOM system. You will need to get this information from PRODOCOM before you attempt any form of API connection. Typically the username is PRODOCOM website login.

password xs:string

The password of this user as stored on the PRODOCOM system. You will need to get this information from PRODOCOM before you attempt any form of API connection.

from_date xs:string

This field and the to_date are optional in place of the update_from_date and update_to_date. Using this option looks at the last time that the jobs where submitted.

The start date and time to look for jobs to be reported. Times and dates are always in GMT and yyyy-mm-dd hh:mm:ss.

If you are only concerned about the date and not the time, simply use 00:00:00 for the time.

to_date xs:string

This field and the from_date are optional in place of the update_from_date and update_to_date. Using this option looks at the last time that the jobs where submitted.

The end date and time to look for jobs to be reported. Times and dates are always in GMT and yyyy-mm-dd hh:mm:ss.

If you are only concerned about the date and not the time, simply use 00:00:00 for the time.

update_from_date xs:string

This field and the update_to_date are optional in place of the from_date and to_date. Using update looks at the last time that the jobs where updated.

The start date and time to look for jobs to be reported. Times and dates are always in GMT and yyyy-mm-dd hh:mm:ss.

If you are only concerned about the date and not the time, simply use 00:00:00 for the time.

update_to_date xs:string

This field and the update_from_date are optional in place of the from_date and to_date. Using update looks at the last time that the jobs where updated.

The end date and time to look for jobs to be reported. Times and dates are always in GMT and yyyy-mm-dd hh:mm:ss.

If you are only concerned about the date and not the time, simply use 00:00:00 for the time.

report_limit xs:string

You can specify a limit to the number of reports you get back at any one time and then where to start this particular search from. Use the report limit to define the number of reports in this request.

limit_start xs:string

You can specify a limit to the number of reports you get back at any one time for a specified time frame and then where to start this particular search from. You use the report_limit to define the number of reports you want and limit_start the starting point. You start with a limit_start of "0" and then if you get back the number of reports in the report limit, you would do another list request for the same time period with a start point of your previous report_limit. Repeat this process until the number of reports returned is less than the report_limit.

Source

<xs:element name="api_request" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element type="xs:string" name="action" />
      <xs:element type="xs:string" name="username" />
      <xs:element type="xs:string" name="password" />
      <xs:element type="xs:string" name="from_date" />
      <xs:element type="xs:string" name="to_date" />
      <xs:element type="xs:string" name="update_from_date" />
      <xs:element type="xs:string" name="update_to_date" />
      <xs:element type="xs:string" name="report_limit" />
      <xs:element type="xs:string" name="limit_start" />
    </xs:sequence>
  </xs:complexType>
</xs:element>